Hybris Sales UX API
Quote Management FIXED
POST (TMF-648)
For PR Market
The Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all the necessary quote parameters.
Functionality Scope
1.Only new customer flow is in scope for installation and technician visit.
2.Telephone (Fixed), Video (TV) and Internet products are in scope.
3.For Telephone only 1Telephone product is in scope.
4.Order can consist of 1P (single product), 2P (two products) and 3P (triple play) in pre-configured set from Hybris, Add on item will be available for internet and Video(TV).
5.If the customer selects an Internet and TV plan in build your own package, telephony is automatically included, and it becomes a 3P Plan.
6.Following are the Products combination in the Scope
Packages | FTTH | COAX |
---|---|---|
1P Telephone | Y | Y |
1P Video/TV | N | Y |
1P Internet | Y | Y |
2P TV + Internet | Y | Y |
2P TV + Phone | N | Y |
2P Internet +Phone | Y | Y |
3P TV + Phone + Internet | Y | Y |
Key Considerations
- No existing customer with order at the location before placing the order, Mulesoft will return error from SLBOS webservices.
- Hybris must follow the business rule in selecting the package and applicable addons in the request sent to the Mulesoft layer, there is no validation of the business rule in mulesoft and will act as pass through and provide any error response from SLBOS api in case the execution failed.
- Once the order is submitted from Mulesoft, CSR guy needs to do manual sales signoff, equipment details update.
- In Video/TV Services, Addon will be applicable as per package tier mentioned in catalogue, Premium package can have premium addons, U-pick packages can have u-pick and premium addon, ultimate package can have ultimate and premium addOn.
- For Installation use cases, use values of Campaign and Reason Code from the table mentioned in this page.
- Installation charges code will be decided by Hybris/CSR based on customer Credit check and user selection. This should be sent with each request as an AddOnProduct for TechnicianVisit and Self install.eg: 0MINS.
- CallType Product code must be sent with any services with Telephone product.
- Bill Preference code (paper bill) must be send with each request as an AddOnProducts from Hybris as mandatory addOn.
- Only one Smart Protect AddOn can be added to product Order.
- Any Extra STB must be sent along with its installation charge code as an AddOn.
- Installation charge Code for the additional STB will depend on TV tier customer have in package.
- Additional Offer product if applicable must be send as an AddOnProduct, For eg: in 3P package nDVR (Cloud DVR) service product code will be send as an AddOnProduct if the TV Box type is Hub TV
- Success Response will contain temporary Order ID along with the temporary accountId of the customer.
- Any Error during execution of underlying BSS Webservice will be passes to Client in Error schema defined in the RAML.
- There is no validation in Mulesoft for the values. Validation errors from CSG will be captured in the response.
- Use Campaign and Reason code from the Table mentioned for self install and Technician visit. Based on that CSG will provide jobType in the response
- Warnings from BSS are captured in the description field.
- Once Order is signed off, no changes(reschedule) are possible.
- Use billingAccount id from the response of create billingAccount in productOrder request(if billing account created before quote API call) else from quote API response.
- Always use next day in requestedQuoteCompletionDate for /quote API call
SelfInstall:
- Temporary Order id, jobType, conversation id(headers), telephone number(TelephoneNumberId) and billingaccount id from the quote API response(if BillingAccount is not created else use it from create billing account response) should be used in /productOrder call.
2. In case of selfinstall, Call quote (requestedQuoteCompletionDate) with next day
- In response, description field will show the warning message "JOB_UNSCHED_ALRT,JBE74A-ENTER OVERRIDE TO UNSCHEDULE JOB,ADP10E-NO DATES AVAILABLE FOR THIS JOB" to create Order(POST /productOrder) with Unscheduled Job(date)
TechnicianVisit:
- Temporary Order id, jobType and conversation id(headers), from the quote API response should be used in /searchTimeSlot call.
- Temporary Order id, jobType, conversation id(headers), telephone number(TelephoneNumberId) and billingaccount id(if BillingAccount is not created else use it from create billing account response) from the quote API response should be used in /productOrder call.
- In case of Slots not available Errors, description in Quote API response contains Warnings/Error message from BSS(also in /searchTimeSlot response) and based on that, Call Product Order API with Unscheduled Job, ie date="4444-12-31T00:00:00.000Z". In case of any outages, BSS allows order creation in the system despite the outage. In both cases, CSR can manually update the ORDER with the required job later and notify the customer about the technician visit through email.
- BSS will block the slot for 4 mins after the searchTimeSlot call, Once it is over, CSG will release the timeslot and it can be Utilized for another customer. If all slots are booked, then customer will get error like "2099 | JOB_TYP_TIME_ALRT-J4U22A-ENTERED DT/TM UNAVAIL"
BaseUriParameter
Name | Type | M/O | Description |
---|---|---|---|
businessId | string | M | Business unit identifier. For LCPR it is ‘PR’ |
Headers
Security Headers client ID and client secret are mandatory to pass under Headers to access API.
Name | Type | M/O | Description |
---|---|---|---|
correlationId | string | CM | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Conditional mandatory field which will be used in logging. Example: f058ebd6-02f7-4d3f-942e-904344e8cde5 |
lob | string | M | This is line of business. Value: “FIXED” |
channelId | String | M* | Expected Value = ECOM M* = Significance in CSG |
targetSystem | String | M* | Expected Value = csg |
Request Body for PR SelfInstall
Note:
Expected values are given below
Self Install
Campaign | Job Reason | Job Type | Description Job | Install Charge | Description | Charge | Technology |
---|---|---|---|---|---|---|---|
SIN | SF | SC | SELF SERV CONNECT | 0MSIN | Current Code | 0.00 | Coax |
SIN | SF | SC | SELF SERV CONNECT | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
SIN | SF | SC | SELF SERV CONNECT | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
SIN | SF | CS | FIB-SELF CONNECT | 0MSIN | Current Code | 0.00 | Fiber |
SIN | SF | CS | FIB-SELF CONNECT | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
SIN | SF | CS | FIB-SELF CONNECT | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
SIN | SF | SS | SELF SERV RESTART | 0MSIN | Current Code | 0.00 | Coax |
SIN | SF | SS | SELF SERV RESTART | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
SIN | SF | SS | SELF SERV RESTART | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
SIN | SF | SF | FIB-SELF RESTART | 0MSIN | Current Code | 0.00 | Fiber |
SIN | SF | SF | FIB-SELF RESTART | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
SIN | SF | SF | FIB-SELF RESTART | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
SIN | SF | US | SELF SERV UPGRADE | 0MSIN | Current Code | 0.00 | Coax |
SIN | SF | US | SELF SERV UPGRADE | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
SIN | SF | US | SELF SERV UPGRADE | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
SIN | SF | SU | FIB-SELF UPGRADE | 0MSIN | Current Code | 0.00 | Fiber |
SIN | SF | SU | FIB-SELF UPGRADE | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
SIN | SF | SU | FIB-SELF UPGRADE | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
- For SelfInstall need to pass "InstallationType" = "SelfInstall"
- requestedQuoteCompletionDate should be the next day.
note Subresource in Request
Name | Type | M/O | Description |
---|---|---|---|
OrderReasonCode | String | Y | SF is default value for self install.E1 for TechnicianVisit. Example: { "text": "SF", "@type": "OrderReasonCode" } |
CampaignCode | String | Y | SIN is default value for self install.ECO for TechnicianVisit. Example: { "text": "SIN", "@type": "CampaignCode" } |
addressNo | String | Y | Location id { "text": "00917000000484", "@type": "addressNo" } |
InstallationType | String | Y | Based on installation type , order will be processed. possible values are "SelfInstall" / "TechnicianVisit"{ "text": "SelfInstall", "@type": "InstallationType" } |
note Subresource in response
Name | Type | M/O | Description |
---|---|---|---|
OrderReasonCode | String | Y | SF is default value for self install. E1 for TechnicianVisit. Example: { "text": "SF", "@type": "OrderReasonCode" } |
CampaignCode | String | Y | SIN is default value for self install, ECO for TechnicianVisit. Example: { "text": "SIN", "@type": "CampaignCode" } |
JobType | String | Y | JobType. Refer table for possible values of SelfInstall and TechnicianVisit. Example: { "text": "SF", "@type": "JobType" } |
addressNo | String | Y | Location id { "text": "00917000000484", "@type": "addressNo" } |
InstallationType | String | Y | possible values are SelfInstall/TechnicianVisit{ "text": "SelfInstall", "@type": "InstallationType" } |
TelephoneNumberId | String | Y | Telephone number generated from BSS { "text": "9395455802", "@type": "TelephoneNumberId" } |
JobId | String | Y | { "text": "00000000000054710001", "@type": "JobId" } |
Technician | String | Y | Technician id { "text": "0701", "@type": "Technician" } |
JobNumber | String | Y | { "text": "00000", "@type": "JobNumber" } |
Possible JobType Values
CTD 32 Values(2Digit) | Description |
---|---|
AO | A/O UPGRADE |
AU | AUDIT |
BD | NW/BURY/DROP |
BN | B2B SELF CONNECT |
BR | B2B SELF RESTART |
BT | BUCKET TRUCK |
BU | B2B SELF UPGRADE |
CP | CONSTRUCTN/PREWIRE |
CS | FIB-SELF CONNECT |
DH | HSD DOWNGRADE |
DN | DOWNGRADE |
EP | EQUIPMENT PICKUP |
FC | FIBER SERVICE CHG |
FM | FIBER MIGRATION |
FN | FTTH INSTALL |
FS | FIBER RESTART |
GA | GUINDOLA |
HC | HSD RECONNECT |
HN | HSD NEW CONNECT |
HR | HSD RESTART |
IT | INST TROUBLE CALL |
KC | COMM-RECONNECT |
KN | COMM-NEW CONNECT |
KR | COMM-RESTART |
KS | BSB F-SELF RESTART |
KU | COMM-UPG |
MN | INTER ESCALATION |
MR | MAINTENANCE\REPAIR |
NC | NEW CONNECT |
NK | BSB F-SELF CONNECT |
NP | NONPAY |
OL | FAT NO OPT LIGHT |
PS | PEND CONSTRUCTION |
RC | RECOONECTS |
RP | REPLACE DROP |
RS | RESTART SERVICE |
RT | RETRENCH\TRENCH |
SC | SELF SERV CONNECT |
SF | FIB-SELF RESTART |
SH | SIDEGRADE |
SP | CERTIFIED NODE |
SR | SYSTEM REPLACEMENT |
SS | SELF SERV RESTART |
SU | FIB-SELF UPGRADE |
TA | TROUBLE CALL |
TB | BS-TROUBLE CALL |
TE | TAP&EQUIP DISCO |
TF | FTTH TROUBLE CALL |
TN | TELE NEW CONNECT |
TP | TP DISCO |
TR | TELE RESTART |
UH | HSD UPGARDE |
UK | B2B F-SELFUPGRADE |
UP | UPGRADE |
US | SELF SERV UPGRADE |
UT | TELE UPGRADE |
VD | VOLUNTARY DISCO |
VS | VERIFY SERVICE |
VT | TRANSFER |
Request for SelfInstall
{
"category": "RES",
"instantSyncQuote": true,
"requestedQuoteCompletionDate": "2023-01-11T12:45:12.028-04:00",
"quoteItem": [
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "RV3BC",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFIPT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFONT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY101",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RZ020",
"quantity": 1,
"action": "add",
"product": {
"id": "RZ020",
"isBundle": false
},
"@type": "AddOnProduct"
},
{
"id": "FRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "FRRUS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MSIN",
"quantity": 1,
"action": "add",
"product": {
"id": "0MSIN",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"note": [
{
"text": "SF",
"@type": "OrderReasonCode"
},
{
"text": "SIN",
"@type": "CampaignCode"
},
{
"text": "00918424400185",
"@type": "addressNo"
},
{
"text": "SelfInstall",
"@type": "InstallationType"
}
],
"relatedParty": [
{
"role": "Buyer Contact",
"id": "1901506139847",
"@referredType": "Customer"
},
{
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "Quote"
}
Response Body for PR SelfInstall
Response Headers:
"x-conversation-id" : "QAHA017633E52B68CF0000"
{
"id": "0000000000000771",
"expectedQuoteCompletionDate": "2023-01-10T08:00:00.000-04:00",
"requestedQuoteCompletionDate": "2023-01-11T12:45:12.028-04:00",
"description": "JOB_UNSCHED_ALRT,JBE74A-ENTER OVERRIDE TO UNSCHEDULE JOB,ADP10E-NO DATES AVAILABLE FOR THIS JOB",
"billingAccount": [
{
"id": "#190150613984701",
"@type": "BillingAccount"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"id": "1901506139847",
"@referredType": "Customer"
},
{
"name": "",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"quoteItem": [
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "F7B3I",
"description": "F3P-Bi-30-Us",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "F3P-Bi-30-Us",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 62.99
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FFIPT",
"description": "Iptv1",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Iptv1",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 2.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FFONT",
"description": "Ont",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Ont",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FJ43X",
"description": "40/40 Mb",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "40/40 Mb",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 35.99
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FW4US",
"description": "F Pr/Us Voip",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "F Pr/Us Voip",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 10.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "RV3BC",
"description": "Broadcast Sv",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Broadcast Sv",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 15.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "ZY101",
"description": "Res Data A/O",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Res Data A/O",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "FRRUS",
"@type": "CallTypeProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "FRRUS",
"description": "Callplanprus",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Callplanprus",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "RZ020",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "RZ020",
"description": "Ndvr 20Hrs",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Ndvr 20Hrs",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "ZMPBI",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "ZMPBI",
"description": "Paper Billin",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Paper Billin",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 3.00
}
}
}
]
},
{
"id": "0MSIN",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "0MSIN",
"description": "Self-Ins Nrc",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Self-Ins Nrc",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
}
],
"quoteTotalPrice": [
{
"name": "PreviousBalance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0.00
}
}
},
{
"name": "Balance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 71.22
},
"taxItem": [
{
"taxAmount": {
"unit": "USD",
"value": 5.23
},
"taxCategory": "TAXES/FEES"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.51
},
"taxCategory": "CARGO POR FRANQUICIA (NET)"
},
{
"taxAmount": {
"unit": "USD",
"value": 3.15
},
"taxCategory": "IVU ESTATAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.30
},
"taxCategory": "IVU MUNICIPAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.08
},
"taxCategory": "CARGO FCC POR SUSCRIPTOR DE CABLE"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.50
},
"taxCategory": "CARGO POR SERVICIO DE 911"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.11
},
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.58
},
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL"
}
]
}
},
{
"name": "ProjectedBalance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0.00
}
}
}
],
"note": [
{
"text": "SF",
"@type": "OrderReasonCode"
},
{
"text": "SIN",
"@type": "CampaignCode"
},
{
"text": "00918424400185",
"@type": "addressNo"
},
{
"text": "SelfInstall",
"@type": "InstallationType"
},
{
"text": "9395455982",
"@type": "TelephoneNumberId"
},
{
"text": "00000000000007710001",
"@type": "JobId"
},
{
"text": "3333",
"@type": "Technician"
},
{
"text": "00000",
"@type": "JobNumber"
},
{
"text": "SF",
"@type": "JobType"
}
],
"type": "Quote"
}
Request Body for PR TechnicianVisit
Note:
Expected values for Installation scope are given below
Campaign | Reason | Job Type | Description Job | Technology |
---|---|---|---|---|
ECO | E1 | FN | FTTH INSTALL | Fiber |
ECO | E1 | FS | FIBER RESTART | Fiber |
ECO | E1 | FC | FIBER SERVICE CHG | Fiber |
ECO | E1 | HC | HSD RECONNECT | Coax |
ECO | E1 | HN | HSD NEW CONNECT | Coax |
ECO | E1 | HR | HSD RESTART | Coax |
ECO | E1 | UH | HSD UPGRADE | Coax |
ECO | E1 | NC | NEW CONNECT | Coax |
ECO | E1 | RC | RECONNECTS | Coax |
ECO | E1 | RS | RESTART SERVICE | Coax |
ECO | E1 | DN | DOWNGRADE | Coax |
ECO | E1 | UP | UPGRADE | Coax |
1.For TechnicianVisit need to pass "InstallationType" = "TechnicianVisit".
2.requestedQuoteCompletionDate should be the next day.
{
"category": "RES",
"instantSyncQuote": true,
"requestedQuoteCompletionDate": "2023-01-25T12:45:12.028-04:00",
"quoteItem": [
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "RV3BC",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFIPT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFONT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY101",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RZ020",
"quantity": 1,
"action": "add",
"product": {
"id": "RZ020",
"isBundle": false
},
"@type": "AddOnProduct"
},
{
"id": "FRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "FRRUS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MINS",
"quantity": 1,
"action": "add",
"product": {
"id": "0MINS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "00918424400185",
"@type": "addressNo"
},
{
"text": "TechnicianVisit",
"@type": "InstallationType"
}
],
"relatedParty": [
{
"role": "Buyer Contact",
"id": "1901506139847",
"@referredType": "Customer"
},
{
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "Quote"
}
Response Body for PR TechnicianVisit
Response Headers:
"x-conversation-id" : "QAHA017633E52B68CF0000"
{
"id": "0000000000003871",
"expectedQuoteCompletionDate": "2023-01-25T08:00:00.000-04:00",
"requestedQuoteCompletionDate": "2023-01-25T12:45:12.028-04:00",
"description": "",
"billingAccount": [
{
"id": "#190150613984701",
"@type": "BillingAccount"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"id": "1901506139847",
"@referredType": "Customer"
},
{
"name": "",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"quoteItem": [
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "F7B3I",
"description": "F3P-Bi-30-Us",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "F3P-Bi-30-Us",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 62.99
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FFIPT",
"description": "Iptv1",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Iptv1",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 2.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FFONT",
"description": "Ont",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Ont",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FJ43X",
"description": "40/40 Mb",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "40/40 Mb",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 35.99
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "FW4US",
"description": "F Pr/Us Voip",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "F Pr/Us Voip",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 10.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "RV3BC",
"description": "Broadcast Sv",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Broadcast Sv",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 15.00
}
}
}
]
},
{
"id": "F7B3I",
"@type": "Package",
"action": "add",
"quantity": 1,
"product": {
"id": "ZY101",
"description": "Res Data A/O",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Res Data A/O",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "FRRUS",
"@type": "CallTypeProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "FRRUS",
"description": "Callplanprus",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Callplanprus",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "RZ020",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "RZ020",
"description": "Ndvr 20Hrs",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Ndvr 20Hrs",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 0.00
}
}
}
]
},
{
"id": "ZMPBI",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "ZMPBI",
"description": "Paper Billin",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "Paper Billin",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 3.00
}
}
}
]
},
{
"id": "0MINS",
"@type": "AddOnProduct",
"action": "add",
"quantity": 1,
"product": {
"id": "0MINS",
"description": "B2C Install",
"@type": "product"
},
"quoteItemPrice": [
{
"description": "B2C Install",
"price": {
"dutyFreeAmount": {
"unit": "USD",
"value": 89.00
}
}
}
]
}
],
"quoteTotalPrice": [
{
"name": "PreviousBalance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0.00
}
}
},
{
"name": "Balance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 170.46
},
"taxItem": [
{
"taxAmount": {
"unit": "USD",
"value": 15.47
},
"taxCategory": "TAXES/FEES"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.51
},
"taxCategory": "CARGO POR FRANQUICIA (NET)"
},
{
"taxAmount": {
"unit": "USD",
"value": 12.50
},
"taxCategory": "IVU ESTATAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 1.19
},
"taxCategory": "IVU MUNICIPAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.08
},
"taxCategory": "CARGO FCC POR SUSCRIPTOR DE CABLE"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.50
},
"taxCategory": "CARGO POR SERVICIO DE 911"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.11
},
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL"
},
{
"taxAmount": {
"unit": "USD",
"value": 0.58
},
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL"
}
]
}
},
{
"name": "ProjectedBalance",
"extendedPrice": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0.00
}
}
}
],
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "00918424400185",
"@type": "addressNo"
},
{
"text": "TechnicianVisit",
"@type": "InstallationType"
},
{
"text": "9395455900",
"@type": "TelephoneNumberId"
},
{
"text": "00000000000038710001",
"@type": "JobId"
},
{
"text": "0701",
"@type": "Technician"
},
{
"text": "00000",
"@type": "JobNumber"
},
{
"text": "FS",
"@type": "JobType"
}
],
"type": "Quote"
}
Possible warnings cases for Description
**Existing customer**:
"description": "ORV59I - EXISTING CUSTOMER AT LOCATION",
**Outage**:
"description": "8211990010051704OTG REASN - AA AUTO OUTAGE DECLARED 13:24 01/02/23",
**NO DATES AVAILABLE FOR THIS JOB/JOB_UNSCHED_ALRT**:
"description": "JOB_UNSCHED_ALRT,JBE74A-ENTER OVERRIDE TO UNSCHEDULE JOB,ADP10E-NO DATES AVAILABLE FOR THIS JOB"
Error Scenarios
When we provided the wrong dueDate
{
"errors": [
{
"code": 400,
"message": "Error Occurred during quote management VERIFYORDERDETAIL:ERROROCCURED",
"description": "2099 - ORD_DUE_DT ORE53E-DUE DATE < ORDER CREATION DATE"
}
]
}